Skip to main content

DataSourceManagerAPI Methods

An object defining methods for the DataSourceManagerAPI class.

SetUrl(url)​

Sets the API URL for requests.

Parameters:​

url (required): string
The new API URL.

Returns:​

Type: void
Method does not return anything

Exceptions:​

Type: ArgumentNullException
Throws ArgumentNullException if URL is null or empty.

Type: Exception
Throws Exception if the URL is invalid.

This is a sync method. Method runs synchronously.

ExecuteQuery<T>(projectName, queryName, parameters, telemetryCollectorHolder)​

Executes a specified query on the data source and returns the result as a typed list.

Parameters:​

projectName (required): string
The name of the project within which the query will be executed.

queryName (required): string
The name of the query to be executed.

parameters (optional): object
The parameters for the query, if any. Default is null.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

Generics:​

Type: T
A generic type parameter that allows the method's return type to be dynamically specified when called, adapting the result to that specific type.

Returns:​

Type: Task<List<T>>
Returns query result as List<T>.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​

GetQueryResultAndStructure(projectName, queryName, parameters, telemetryCollectorHolder)​

Executes a specified query on the data source and returns both the result and the structure of the data.

Parameters:​

projectName (required): string
The name of the project within which the query will be executed.

queryName (required): string
The name of the query to be executed.

parameters (optional): object
The parameters for the query, if any. Default is null.

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data. This property is advance using only.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also​